Version: 1.0.2

Activate or Deactivate Beneficiary by Id

The Activate or Deactivate Beneficiary by Id API is used to activate or deactivate a beneficiary identified by their unique beneficiaryID. The legal representative with the "CanManageBeneficiary" permission is authorized to perform this action.

Method: POST

{{URL}}/jsonrpc

Headers

Name	Value
Content-Type	application/json

Example

Payload Parameters

Parameter	Description
beneficiaryID Mandatory	String The unique identifier of the beneficiary to be activated or deactivated Ex:"64de05c12665cd17cdfd5f4d "
customerID Mandatory	String The unique identifier of the customer associated with the beneficiary Ex:"100000000048001 "
action Mandatory	String The action to perform Ex:"DEACTIVATE "

Parameter

Description

beneficiaryID

Mandatory

String

The unique identifier of the beneficiary to be activated or deactivated

Ex:"64de05c12665cd17cdfd5f4d "

customerID

Mandatory

String

The unique identifier of the customer associated with the beneficiary

Ex:"100000000048001 "

action

Mandatory

String

The action to perform

Ex:"DEACTIVATE "

cURL
C#
Go
NodeJs

curl --location 'https://wallet.netxd.com/plwallet/rpc/WalletService/ActivateOrDeActivateBeneficiaryByID' \
--header 'DeviceID: 8020' \
--header 'Signature: keyId=8020,algorithm=ecdsa-sha256,signature=MEUCIQCNi1vjPf/HpI9R2DXnc0Zt1s6YmWyA4H1x813lJ+tuDgIgB+lrc+iCMyTUGiraG9kGKNDXYiz7RfBBtifr5wUQs54=' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic ci5hbmJhbGFnYW5AbmV0eGQuY29tOmQ0Mjc2ZmIx' \
--data '{"beneficiaryID":"64de05c12665cd17cdfd5f4d","customerID":"100000000048001","action":"DEACTIVATE"}'

var options = new RestClientOptions("https://wallet.netxd.com")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("/plwallet/rpc/WalletService/ActivateOrDeActivateBeneficiaryByID", Method.Post);
request.AddHeader("DeviceID", "8020");
request.AddHeader("Signature", "keyId=8020,algorithm=ecdsa-sha256,signature=MEUCIQCNi1vjPf/HpI9R2DXnc0Zt1s6YmWyA4H1x813lJ+tuDgIgB+lrc+iCMyTUGiraG9kGKNDXYiz7RfBBtifr5wUQs54=");
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Basic ci5hbmJhbGFnYW5AbmV0eGQuY29tOmQ0Mjc2ZmIx");
var body = @"{" + "\n" +
@"    ""beneficiaryID"": ""64de05c12665cd17cdfd5f4d""," + "\n" +
@"    ""customerID"": ""100000000048001""," + "\n" +
@"    ""action"": ""DEACTIVATE""" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://wallet.netxd.com/plwallet/rpc/WalletService/ActivateOrDeActivateBeneficiaryByID"
  method := "POST"

  payload := strings.NewReader(`{
    "beneficiaryID": "64de05c12665cd17cdfd5f4d",
    "customerID": "100000000048001",
    "action": "DEACTIVATE"
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("DeviceID", "8020")
  req.Header.Add("Signature", "keyId=8020,algorithm=ecdsa-sha256,signature=MEUCIQCNi1vjPf/HpI9R2DXnc0Zt1s6YmWyA4H1x813lJ+tuDgIgB+lrc+iCMyTUGiraG9kGKNDXYiz7RfBBtifr5wUQs54=")
  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("Authorization", "Basic ci5hbmJhbGFnYW5AbmV0eGQuY29tOmQ0Mjc2ZmIx")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
  'method': 'POST',
  'hostname': 'wallet.netxd.com',
  'path': '/plwallet/rpc/WalletService/ActivateOrDeActivateBeneficiaryByID',
  'headers': {
    'DeviceID': '8020',
    'Signature': 'keyId=8020,algorithm=ecdsa-sha256,signature=MEUCIQCNi1vjPf/HpI9R2DXnc0Zt1s6YmWyA4H1x813lJ+tuDgIgB+lrc+iCMyTUGiraG9kGKNDXYiz7RfBBtifr5wUQs54=',
    'Content-Type': 'application/json',
    'Authorization': 'Basic ci5hbmJhbGFnYW5AbmV0eGQuY29tOmQ0Mjc2ZmIx'
  },
  'maxRedirects': 20
};

var req = https.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function (chunk) {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });

  res.on("error", function (error) {
    console.error(error);
  });
});

var postData = JSON.stringify({
  "beneficiaryID": "64de05c12665cd17cdfd5f4d",
  "customerID": "100000000048001",
  "action": "DEACTIVATE"
});

req.write(postData);

req.end();

Body

{
    "beneficiaryID": "64de05c12665cd17cdfd5f4d",
    "customerID": "100000000048001",
    "action": "DEACTIVATE"
}

Response: 200

Response Parameters

Parameter	Description
ID	String Unique identifier of the beneficiary Ex:"64de05c12665cd17cdfd5f4d "
createdDate	String Timestamp indicating when the beneficiary entity was created Ex:"2023-08-17T11:34:25.813Z "
updatedDate	String Timestamp indicating the most recent update to the beneficiary entity Ex:"0001-01-01T00:00:00Z "
type	String Type of beneficiary Ex:"BUSINESS", "INDIVIDUAL "
firstName	String First name of the beneficiary Ex:"Reddygari "
lastName	String Last name of the beneficiary Ex:"ChennReddy "
accountType	String Account type Ex:"DIGITALASSET "
contact	Object
email	String Email address of the beneficiary Ex:"chennareddy.s+099@netxd.com "
phoneNumber	String Phone number of the beneficiary Ex:"1212144555 "
address	Object
line1	String Address line 1 Ex:"alaska "
city	String City of the beneficiary's address Ex:"Seattle "
state	String State of the beneficiary's address Ex:"WA "
country	String Country of the beneficiary's address Ex:"US "
zipCode	String Zip code of the beneficiary's address Ex:"98104 "
createdBy	String Email address of the user who created the beneficiary Ex:"chennareddy.s+106@netxd.com "
status	String Status of the beneficiary Ex:"INACTIVE "
customerID	String Unique identifier of the customer associated with the beneficiary Ex:"100000000048001 "
publicKey	String Public key associated with the beneficiary Ex:"GAL3PT3LC3JPAIAZ3LU2YOKCXXQ24MLVJCYDCR7PRD6YHCBQNAF3WFNW "
network	String Network associated with the beneficiary Ex:"STELLER "
ceResponse	Object
result	String Context Engine watchlist result Ex:"success "
detail	String Context Engine watchlist details Ex:"success "
risk	Object
riskScore	String Risk score of the beneficiary Ex:"0 "
ofac	Object
watchList	Object
INDIVIDUALTransactionNumber	String Individual Transaction number Ex:"1707 "
updateHistory	Array
userName	String User who performed the update Ex:"chennareddy.s+106@netxd.com "
updatedDate	String Timestamp of the update Ex:"2023-08-17T11:35:04.513Z "
isInternal	Boolean Indicates whether the beneficiary is internal (true) or external (false) Ex:true

{
  "ID": "64de05c12665cd17cdfd5f4d",
  "createdDate": "2023-08-17T11:34:25.813Z",
  "updatedDate": "0001-01-01T00:00:00Z",
  "type": "INDIVIDUAL",
  "firstName": "Reddygari",
  "lastName": "ChennReddy",
  "accountType": "DIGITALASSET",
  "contact": {
    "email": "chennareddy.s+099@netxd.com",
    "phoneNumber": "1212144555"
  },
  "address": {
    "line1": "edit test",
    "city": "Seattle",
    "state": "WA",
    "country": "US",
    "zipCode": "98104"
  },
  "createdBy": "chennareddy.s+106@netxd.com",
  "status": "INACTIVE",
  "customerID": "100000000048001",
  "publicKey": "GAL3PT3LC3JPAIAZ3LU2YOKCXXQ24MLVJCYDCR7PRD6YHCBQNAF3WFNW",
  "network": "STELLER",
  "ceResponse": {
    "result": "success",
    "detail": "success",
    "risk": {
      "riskScore": "0"
    },
    "ofac": {},
    "watchList": {},
    "INDIVIDUALTransactionNumber": "1707"
  },
  "updateHistory": [
    {
      "userName": "chennareddy.s+106@netxd.com",
      "updatedDate": "2023-08-17T11:35:04.513Z"
    },
    {
      "userName": "chennareddy.s+106@netxd.com",
      "updatedDate": "2023-08-17T11:36:09.152Z"
    },
    {
      "userName": "chennareddy.s+106@netxd.com",
      "updatedDate": "2023-08-17T11:36:53.823Z"
    },
    {
      "userName": "chennareddy.s+106@netxd.com",
      "updatedDate": "2023-08-17T13:10:17.347Z"
    }
  ],
  "isInternal": true
}

Activate or Deactivate Beneficiary by Id

Method: POST​

Headers​

Example​

Body​

Response: 200​

Method: POST

Headers

Example

Body

Response: 200